Class Routes

Summary

Fully Qualified Name: CodeIgniter\Debug\Toolbar\Collectors\Routes
Extends: BaseCollector

Description

Routes collector

Methods

Name Description Defined By
cleanPath() Clean Path BaseCollector
display() Returns the data of this collector to be formatted in the toolbar Routes
getAsArray() Return settings as an array. BaseCollector
getBadgeValue() Returns a count of all the routes in the system. Routes
getTitle() Gets the Collector's title. BaseCollector
getTitleDetails() Returns any information that should be shown next to the title. BaseCollector
getVarData() Gets a collection of data that should be shown in the 'Vars' tab. BaseCollector
hasLabel() Does this collector have a label? BaseCollector
hasTabContent() Does this collector need it's own tab? BaseCollector
hasTimelineData() Does this collector have information for the timeline? BaseCollector
hasVarData() Does this Collector have data that should be shown in the 'Vars' tab? BaseCollector
icon() Display the icon. Routes
isEmpty() Does this collector have any data collected? BaseCollector
timelineData() Grabs the data for the timeline, properly formatted, or returns an empty array. BaseCollector

Method Details

cleanPath()

Clean Path

This makes nicer looking paths for the error output.

Parameter Name Type Description
$file string

Returns: string

display()

Returns the data of this collector to be formatted in the toolbar

Returns: array

getAsArray()

Return settings as an array.

Returns: array

getBadgeValue()

Returns a count of all the routes in the system.

Returns: int

getTitle()

Gets the Collector's title.

Parameter Name Type Description
$safe bool

Returns: string

getTitleDetails()

Returns any information that should be shown next to the title.

Returns: string

getVarData()

Gets a collection of data that should be shown in the 'Vars' tab.

The format is an array of sections, each with their own array of key/value pairs:

$data = [

 'section 1' => [
     'foo' => 'bar,
     'bar' => 'baz'
 ],
 'section 2' => [
     'foo' => 'bar,
     'bar' => 'baz'
 ],

];

Returns: null

hasLabel()

Does this collector have a label?

Returns: bool

hasTabContent()

Does this collector need it's own tab?

Returns: bool

hasTimelineData()

Does this collector have information for the timeline?

Returns: bool

hasVarData()

Does this Collector have data that should be shown in the 'Vars' tab?

Returns: bool

icon()

Display the icon.

Icon from https://icons8.com - 1em package

Returns: string

isEmpty()

Does this collector have any data collected?

If not, then the toolbar button won't get shown.

Returns: bool

timelineData()

Grabs the data for the timeline, properly formatted, or returns an empty array.

Returns: array

Top